docs: document automatic skill-load marks [3/3]#393
Conversation
github-actions
Bot
added
size:XL
WalkthroughDocuments automatic ChangesSkill-load observability documentation
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Important Pre-merge checks failedPlease resolve all errors before merging. Addressing warnings is optional. ❌ Failed checks (1 error)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
License DiffCompared against Lockfile license changesLockfile License ChangesRustAdded
Removed
Updated/Changed
NodeAdded
Removed
Updated/Changed
PythonAdded
Removed
Updated/Changed
Status output |
mnajafian-nv
left a comment
mnajafian-nv
left a comment
There was a problem hiding this comment.
Great work on documenting the skill-load contract across the host and integration surfaces. One docs consistency gap remains outside this diff: docs/nemo-relay-cli/basic-usage.mdx still lists the Claude Code and Codex hook bundles only through PreCompact, while this PR adds UserPromptExpansion to the host-specific docs. That leaves readers with conflicting answers depending on which page they open first. I’d update the top-level hook matrix in the same stack, or explicitly call out the follow-up if it is being deferred.
willkill07
force-pushed
the
wkk_relay-443-docs
branch
from
27af737 to
da34f6b
Compare
Signed-off-by: Will Killian <wkillian@nvidia.com>
github-actions
Bot
removed
lang:js
willkill07
force-pushed
the
wkk_relay-443-docs
branch
from
da34f6b to
e42c20b
Compare
github-actions
Bot
added
size:M
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/about-nemo-relay/concepts/events.mdx`:
- Around line 117-127: Update the exact event example in the events
documentation to include the envelope fields parent_uuid and timestamp with
their serialized types, matching the implementation’s mark event shape;
alternatively, explicitly label the example as payload-only rather than
complete.
In `@docs/nemo-relay-cli/hermes.mdx`:
- Around line 131-132: The documentation should distinguish the mark payload
from its metadata: rewrite the Hermes `skill_view` description so `data` is said
to contain only `skill_name`, while metadata records `skill_load_source` and
`tool_name`; retain that skill paths are omitted.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Enterprise
Run ID: ccc7e9b4-8f20-4638-aa66-308de8bb8dd9
📒 Files selected for processing (8)
docs/about-nemo-relay/concepts/events.mdxdocs/nemo-relay-cli/basic-usage.mdxdocs/nemo-relay-cli/claude-code.mdxdocs/nemo-relay-cli/codex.mdxdocs/nemo-relay-cli/hermes.mdxdocs/supported-integrations/about.mdxdocs/supported-integrations/deepagents.mdxskills/nemo-relay-setup-observability/SKILL.md
📜 Review details
⏰ Context from checks skipped due to timeout. (2)
- GitHub Check: CodeRabbit
- GitHub Check: Preview docs
🧰 Additional context used
📓 Path-based instructions (14)
**/*.mdx
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)
MDX top-of-file SPDX comments must use {/* ... */} delimiters instead of HTML comment delimiters (Must-Fix)
In MDX files, top-of-file comments must use JSX comment delimiters (
{/*to open and*/}to close); do not use HTML comments for MDX SPDX headers
Files:
docs/supported-integrations/about.mdxdocs/supported-integrations/deepagents.mdxdocs/nemo-relay-cli/hermes.mdxdocs/nemo-relay-cli/claude-code.mdxdocs/nemo-relay-cli/codex.mdxdocs/about-nemo-relay/concepts/events.mdxdocs/nemo-relay-cli/basic-usage.mdx
**/*.{md,mdx}
📄 CodeRabbit inference engine (AGENTS.md)
Update
README.md,fern/, package READMEs, and binding-support notes when public behavior, package names, examples, or supported bindings change.
**/*.{md,mdx}: Prefer the documented public API, not internal shortcuts
Keep package names, repo references, and build commands current
Keep release-process and release-notes guidance in repo-maintainer docs such asRELEASING.md, not as user-facing docs pages orCHANGELOG.md
Keep stable user-facing wrappers atscripts/root in docs and examples; only point at namespaced helper paths when documenting internal maintenance work
When detailed dynamic plugin guides exist, keep Rust native plugin examples, Python worker plugin examples, andgrpc-v1protocol details on separate pagesIf links in documentation change, run
just docs-linkcheck.
Files:
docs/supported-integrations/about.mdxdocs/supported-integrations/deepagents.mdxskills/nemo-relay-setup-observability/SKILL.mddocs/nemo-relay-cli/hermes.mdxdocs/nemo-relay-cli/claude-code.mdxdocs/nemo-relay-cli/codex.mdxdocs/about-nemo-relay/concepts/events.mdxdocs/nemo-relay-cli/basic-usage.mdx
**/*.{md,markdown,mdx}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Add the SPDX license header to all Markdown/MDX documentation files using the HTML comment block form.
Files:
docs/supported-integrations/about.mdxdocs/supported-integrations/deepagents.mdxskills/nemo-relay-setup-observability/SKILL.mddocs/nemo-relay-cli/hermes.mdxdocs/nemo-relay-cli/claude-code.mdxdocs/nemo-relay-cli/codex.mdxdocs/about-nemo-relay/concepts/events.mdxdocs/nemo-relay-cli/basic-usage.mdx
{docs,examples}/**/*
📄 CodeRabbit inference engine (.agents/skills/rename-surfaces/SKILL.md)
Update docs and examples.
Files:
docs/supported-integrations/about.mdxdocs/supported-integrations/deepagents.mdxdocs/nemo-relay-cli/hermes.mdxdocs/nemo-relay-cli/claude-code.mdxdocs/nemo-relay-cli/codex.mdxdocs/about-nemo-relay/concepts/events.mdxdocs/nemo-relay-cli/basic-usage.mdx
**/*
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
**/*: Format changed files with the language-native formatter before the final lint/test pass.
If dynamic plugin behavior changed, usemaintain-dynamic-pluginsand include the native SDK, worker protocol, Python SDK, docs, packaging, and Codecov surfaces in the validation plan.
If code changes alter APIs, bindings, commands, paths, packaging behavior, observability/adaptive semantics, or documented best practices, update any dependent maintainer or consumer skills in the same branch.
During iteration, preferuv run pre-commit run --files <changed files...>.
Before review or handoff, runuv run pre-commit run --all-files.
Files:
docs/supported-integrations/about.mdxdocs/supported-integrations/deepagents.mdxskills/nemo-relay-setup-observability/SKILL.mddocs/nemo-relay-cli/hermes.mdxdocs/nemo-relay-cli/claude-code.mdxdocs/nemo-relay-cli/codex.mdxdocs/about-nemo-relay/concepts/events.mdxdocs/nemo-relay-cli/basic-usage.mdx
docs/**/*
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
If documentation examples or commands under
docs/change, run the targeted docs checks appropriate to the change.
Files:
docs/supported-integrations/about.mdxdocs/supported-integrations/deepagents.mdxdocs/nemo-relay-cli/hermes.mdxdocs/nemo-relay-cli/claude-code.mdxdocs/nemo-relay-cli/codex.mdxdocs/about-nemo-relay/concepts/events.mdxdocs/nemo-relay-cli/basic-usage.mdx
**
⚙️ CodeRabbit configuration file
**:AGENTS.md
This file provides guidance to agents, including Claude Code and OpenAI Codex, when working in this repository.
Project Overview
NeMo Relay is a multi-language agent runtime framework for execution scopes, lifecycle events, middleware, plugins, and observability around tool and LLM calls. The core runtime is Rust. Primary supported bindings are Rust, Python, and Node.js. Go and the raw C FFI are experimental and source-first.
The shared runtime model is:
- Scope stacks decide where work belongs and which scope-local behavior is visible.
- Middleware registries decide what guardrails and intercepts run around managed calls.
- Plugins install reusable runtime behavior from configuration.
- Events record runtime behavior in ATOF form.
- Subscribers and exporters consume events in-process or export them to ATIF, OpenTelemetry, OpenInference, or other backends.
Repository Structure
The repository layout separates the Rust runtime, language bindings,
documentation, integrations, and agent-facing skills.crates/ core/ # Rust core runtime crate, published as nemo-relay adaptive/ # Adaptive runtime primitives and plugin components python/ # PyO3 native extension for the Python package ffi/ # Raw C ABI layer used by downstream bindings such as Go node/ # NAPI Node.js binding and JavaScript/TypeScript entry points python/ nemo_relay/ # Python wrapper package: scopes, tools, LLM, middleware, typed helpers, plugins, adaptive helpers tests/ # Python tests go/ nemo_relay/ # Experimental Go CGo binding and tests fern/ # Fern documentation site scripts/ # Stable wrappers and helper scripts; build/test/docs entry points live in justfile skills/ # Published Codex/agent skills for NeMo Relay usage patternsPrerequisites
Insta...
Files:
docs/supported-integrations/about.mdxdocs/supported-integrations/deepagents.mdxskills/nemo-relay-setup-observability/SKILL.mddocs/nemo-relay-cli/hermes.mdxdocs/nemo-relay-cli/claude-code.mdxdocs/nemo-relay-cli/codex.mdxdocs/about-nemo-relay/concepts/events.mdxdocs/nemo-relay-cli/basic-usage.mdx
{docs/**,README.md,CONTRIBUTING.md,RELEASING.md,SECURITY.md}
⚙️ CodeRabbit configuration file
{docs/**,README.md,CONTRIBUTING.md,RELEASING.md,SECURITY.md}: Review documentation for technical accuracy against the current API, command correctness, and consistency across language bindings.
Flag stale examples, missing SPDX headers where required, and instructions that no longer match CI or pre-commit behavior.
Files:
docs/supported-integrations/about.mdxdocs/supported-integrations/deepagents.mdxdocs/nemo-relay-cli/hermes.mdxdocs/nemo-relay-cli/claude-code.mdxdocs/nemo-relay-cli/codex.mdxdocs/about-nemo-relay/concepts/events.mdxdocs/nemo-relay-cli/basic-usage.mdx
**/*.{md,rst,html,txt}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-brand-terminology.md)
**/*.{md,rst,html,txt}: Always spellNVIDIAin all caps. Do not useNvidia,nvidia,nVidia,nVIDIA, orNV.
Usean NVIDIAbefore a noun because the name starts with an 'en' sound.
Do not add a registered trademark symbol afterNVIDIAwhen referring to the company.
Use trademark symbols with product names only when the document type or legal guidance requires them.
Verify official capitalization, spacing, and hyphenation for product names.
Precede NVIDIA product names withNVIDIAon first mention when it is natural and accurate.
Do not rewrite product names for grammar or title-case rules.
Preserve third-party product names according to the owner's spelling.
Include the company name and full model qualifier on first use when it helps identify the model.
Preserve the official capitalization and punctuation of model names.
Use shorter family names only after the full name is established.
Spell out a term on first use and put the acronym in parentheses unless the acronym is widely understood by the intended audience.
Use the acronym on later mentions after it has been defined.
For long documents, reintroduce the full term if readers might lose context.
Form plurals of acronyms withs, not an apostrophe, such asGPUs.
In headings, common acronyms can remain abbreviated. Spell out the term in the first or second sentence of the body.
Common terms such asCPU,GPU,PC,API, andUIusually do not need to be spelled out for developer audiences.
Files:
skills/nemo-relay-setup-observability/SKILL.md
**/*.{md,rst,html}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-brand-terminology.md)
Link the first mention of a product name when the destination helps the reader.
Files:
skills/nemo-relay-setup-observability/SKILL.md
**/*.{md,rst,txt}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)
Spell
NVIDIAin all caps. Do not useNvidia,nvidia, orNV.
Files:
skills/nemo-relay-setup-observability/SKILL.md
**/*.{md,rst}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)
**/*.{md,rst}: Format commands, code elements, expressions, package names, file names, and paths as inline code.
Use descriptive link text. Avoid raw URLs and weak anchors such as "here" or "read more."
Use title case consistently for technical documentation headings.
Introduce code blocks, lists, tables, and images with complete sentences.
Write procedures as imperative steps. Keep steps parallel and split long procedures into smaller tasks.
Prefer active voice, present tense, short sentences, contractions, and plain English.
Usecanfor possibility and reservemayfor permission.
Useafterfor temporal relationships instead ofonce.
Preferrefer tooverseewhen the wording points readers to another resource.
Avoid culture-specific idioms, unnecessary Latinisms, jokes, and marketing exaggeration in technical docs.
Spell out months in body text, avoid ordinal dates, and use clear time zones.
Spell out whole numbers from zero through nine unless they are technical values, parameters, versions, or UI values.
Use numerals for 10 or greater and include commas in thousands.
Do not add trademark symbols to learning-oriented docs unless the source, platform, or legal guidance explicitly requires them.
Files:
skills/nemo-relay-setup-observability/SKILL.md
**/*.md
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-technical-docs.md)
**/*.md: Use title case consistently in technical documentation headings
Avoid quotation marks, ampersands, and exclamation marks in headings
Keep product, event, research, and whitepaper names in their official title case
Use title case for table headers
Do not force social-media sentence case into technical docs
Format code elements, commands, parameters, package names, and expressions in monospace
Format directories, file names, and paths in monospace using backticks
Use angle brackets inside monospace for variables inside paths, such as/home/<username>/.login
Format error messages and strings in quotation marks, keeping literal code strings in code formatting when clearer
Format UI buttons, menus, fields, and labels in bold
Use angle brackets between UI labels for menu paths, such as File > Save As
Use italics for new terms on first use, sparingly and only when introducing the term
Use italics for publication titles
Format keyboard shortcuts in plain text, such as Press Ctrl+Alt+Delete
Use owner/repo link text for GitHub repositories, preferring[NVIDIA/NeMo](link)over prose references like 'the GitHub repo'
Introduce every code block with a complete sentence
Do not make a code block complete the grammar of the previous sentence
Do not continue a sentence after a code block
Use syntax highlighting when the format supports it for code blocks
Avoid the word 'snippet' unless the surrounding docs already use it as a term of art
Keep inline method, function, and class references consistent with nearby docs, omitting empty parentheses for prose readability when no call is shown
Use descriptive anchor text that matches the destination title when possible for links
Avoid raw URLs in running text
Avoid generic anchor text such as 'here,' 'this page,' and 'read more'
Include acronyms in link text when a linked term includes an acronym
Do not link long sentences or multiple sentences
Avoid links that pull readers away from a procedure unless the link is a p...
Files:
skills/nemo-relay-setup-observability/SKILL.md
**/SKILL.md
📄 CodeRabbit inference engine (AGENTS.md)
SKILL.mdfiles are skill entrypoints and must start with YAML frontmatter containing at leastnameanddescription.
Files:
skills/nemo-relay-setup-observability/SKILL.md
⚙️ CodeRabbit configuration file
**/SKILL.md: Do not flag SKILL.md files for missing SPDX headers. Skill entrypoints intentionally start with YAML frontmatter instead.
Verify that every SKILL.md keeps valid YAML frontmatter with at least name and description fields before the Markdown body.
Files:
skills/nemo-relay-setup-observability/SKILL.md
🔇 Additional comments (9)
docs/about-nemo-relay/concepts/events.mdx (2)
112-116: LGTM!Also applies to: 129-153
155-158: 🗄️ Data Integrity & IntegrationNo change needed. ATIF omits marks, and OpenTelemetry/OpenInference honor
mark_projectionfor parented marks.skills/nemo-relay-setup-observability/SKILL.md (2)
44-47: LGTM!
44-47: 📐 Maintainability & Code QualityNo issue:
skills/nemo-relay-setup-observability/SKILL.mdalready has valid YAML frontmatter withnameanddescription.> Likely an incorrect or invalid review comment.docs/nemo-relay-cli/basic-usage.mdx (1)
309-309: LGTM!docs/nemo-relay-cli/claude-code.mdx (1)
126-129: LGTM!docs/nemo-relay-cli/codex.mdx (1)
184-186: LGTM!docs/supported-integrations/about.mdx (1)
43-44: LGTM!docs/supported-integrations/deepagents.mdx (1)
112-113: LGTM!
| ```json | ||
| { | ||
| "kind": "mark", | ||
| "name": "skill.load", | ||
| "data": {"skill_name": "review"}, | ||
| "metadata": { | ||
| "skill_load_source": "structured_read", | ||
| "tool_name": "read_file" | ||
| } | ||
| } | ||
| ``` |
There was a problem hiding this comment.
🗄️ Data Integrity & Integration | 🟡 Minor | ⚡ Quick win
Make the “exact” event example include its envelope fields.
The implementation also sets parent_uuid and timestamp on each mark, but the example omits them while presenting itself as the complete observed shape. Either include those fields with their serialized types or label this example as the payload-only shape.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/about-nemo-relay/concepts/events.mdx` around lines 117 - 127, Update the
exact event example in the events documentation to include the envelope fields
parent_uuid and timestamp with their serialized types, matching the
implementation’s mark event shape; alternatively, explicitly label the example
as payload-only rather than complete.
| Hermes `skill_view` pre-tool calls emit observed `skill.load` marks. The mark | ||
| contains only the skill name and tool identity; it does not retain skill paths. |
There was a problem hiding this comment.
🗄️ Data Integrity & Integration | 🟡 Minor | ⚡ Quick win
Distinguish the payload from the complete mark metadata.
The canonical mark contains only skill_name in data, but its metadata also includes skill_load_source and tool_name. Rewrite this as “the payload contains only the skill name; metadata records the load source and tool name,” while retaining the statement that paths are omitted.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/nemo-relay-cli/hermes.mdx` around lines 131 - 132, The documentation
should distinguish the mark payload from its metadata: rewrite the Hermes
`skill_view` description so `data` is said to contain only `skill_name`, while
metadata records `skill_load_source` and `tool_name`; retain that skill paths
are omitted.
2 participants
Overview
Documents RELAY-443 automatic skill-load marks across coding agents, framework integrations, exporters, and observability guidance. This is the third commit in a three-PR cumulative stack; all three PRs target upstream
mainas requested, so this PR temporarily includes the first two commits until they merge.Details
Validation:
just docs, documentation link checks, anduv run pre-commit run --all-files.Breaking changes: none.
Where should the reviewer start?
Start with
docs/about-nemo-relay/concepts/events.mdx, then review the host-specific CLI and integration pages.Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)
Summary by CodeRabbit
skill.loadmarks for completeSKILL.mdreads during tool execution.